Document Unpackerr v1 upgrades - #54
davidnewhall wants to merge 9 commits into
Conversation
Whisparr uses the Radarr API, so the docs should tell people to configure it as a named Radarr instance. Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
…xample. Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
![qwen-pr-bot[bot]](https://avatars.githubusercontent.com/in/4697433?s=60&v=4){kind=small}
There was a problem hiding this comment.
Reviewed all five commits at 516b9b1 against base 2d65270. This bundles more than the title says: the Whisparr→Radarr documentation, a new Upgrading to v1 page, a rewrite of the multi-instance config section (array rows → named keys), a unRAID page rewrite, and a sidebar entry — plus a real fix: the template link main → master, since selfhosters' default branch is master and the old link 404s.
The new page renders cleanly with its sidebar entry:
And the configuration page's rewritten sections (Web UI, Two+ Instances, Whisparr, Named instances) land as described:
I cross-checked every v1 claim against Unpackerr/unpackerr@main (and v0.16.1 where it matters), and they all hold: port 5656 with listen_addr = "" as the off switch, the one-time temporary admin password plus --reset, UI Save rewriting the config file, env-owned values locked out of UI saves, named keys with legacy [[…]] rows loading as 0, 1, …, Whisparr as a plain Radarr instance (v0.16.1 already drove it with the Radarr client, so the rename is honest), /metrics requiring an API key with system:metrics:read, packages installing /etc/unpackerr/unpackerr.conf at 0644 with the post-install chown, and Docker writing /config/unpackerr.conf when the directory exists. The intro/FAQ wording matches the app's own v1 definitions.
One blocking item: the unRAID template descriptions are ahead of the public record — see the inlines on unraid.md:13 and upgrading.md:113. The linked selfhosters template is still env-var-only, and I found no v1 template in either public CA repo. As written, a user who pulls v1 and follows "remove the container, install again from Apps, open the WebUI" ends up with no port exposed and no appdata to leave in place. If the template update is already in flight, say so and soften the tense; otherwise hold the unRAID rewrite until it's public.
Executed validation (advanced mode — the docs repo's documented checks only; no app binaries were run):
yarn install --frozen-lockfile;yarn lint(markdownlint-cli2): 0 issues in 25 filescodespell docs: cleanyarn build(which runs./generate.sh→go run github.com/Unpackerr/unpackerr/init/config@main→docusaurus build): success at both head and base. Only warning is a broken anchor on/docs/install/windows— pre-existing at base, not introduced here.- Served the head build on loopback and rendered the pages with headless Chromium; verified the rendered sections in the built HTML (screenshots above).
bakerboy448
left a comment
bakerboy448
left a comment
There was a problem hiding this comment.
Seems reasonable from human eyes. Can have Claude give it a whirl. Lemme know
davidnewhall
changed the title
|
Don't need Claude. Just need you to breeze it over and let me know if something is confusing. |
Docker no longer auto-polls via folders.interval; call out wait_extensions, skip_empty, and history restore so upgrades do not leave an empty queue. Co-authored-by: Cursor <cursoragent@cursor.com>
split_flac covers both images, and ape_format plus ape_compression choose what an APE image becomes. Co-authored-by: Cursor <cursoragent@cursor.com>
| Lidarr only. `split_flac` splits a completed download that has a CUE sheet. | ||
| It splits both FLAC and APE images into one file per track, then asks Lidarr | ||
| to import those tracks. Sonarr, Radarr, and Readarr ignore this setting. | ||
| A watched folder does not split cue sheets. |
There was a problem hiding this comment.
This sentence doesn't hold up against the code. The folder watcher's extract call uses xtractr's full archive recognition, and .cue is in that list (IsArchiveFile), so a watched folder containing album.flac plus album.cue gets its tracks split today. I reproduced it with a throwaway harness running xtractr v0.7.0 in extractTrackedItem's exact call shape, and it split into 01/02/03 tracks. Either correct the sentence (the folder watcher does extract cue sheets, it just has no split_flac/ape_format toggle), or, if folders are supposed to leave cue sheets alone, that's an app change to extractTrackedItem's suffix list, not a docs one.
There was a problem hiding this comment.
The new commit is otherwise solid — every APE/split claim checks out against the code and tests (xtractr v0.7.0 cue/APE suites pass, TestStarrArchiveTypesAndAPEOpts and TestConfigPutLidarrAPESettings pass at the head). One sentence in the new section misdescribes watched-folder behavior, so requesting changes on that single point, inlined below.
This branch has not been deployed
2 participants
Summary
/config, and unRAID migrate-or-reinstall.[radarr.whisparr]/UN_RADARR_whisparr_*) and named Starr/folder/hook keys.folders.interval/ Docker 1s auto-poll), restore after restart,wait_extensions,skip_empty.Test plan
UN_FOLDER_<key>_INTERVAL=1s, notUN_FOLDERS_INTERVAL